package com.walmartlabs.concord.runtime.v2.model;

/*-
 * *****
 * Concord
 * -----
 * Copyright (C) 2017 - 2020 Walmart Inc.
 * -----
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * =====
 */

import org.immutables.value.Value;

import javax.annotation.Nullable;
import java.io.Serializable;

@Value.Immutable
@Value.Style(jdkOnly = true)
public interface Location extends Serializable {

    long serialVersionUID = 1L;

    static String toShortString(Location location) {
        if (location == null || location.fileName() == null) {
            return "n/a";
        }

        return "line: " + location.lineNum() + ", col: " + location.column();
    }

    static String toErrorPrefix(Location location) {
        if (location == null || location.fileName() == null) {
            return "(n/a): Error.";
        } else {
            return "(" + location.fileName() + "): Error @ " + toShortString(location) + ".";
        }
    }

    @Value.Default
    default int lineNum() {
        return -1;
    }

    @Value.Default
    default int column() {
        return -1;
    }

    @Nullable
    String fileName();

    static ImmutableLocation.Builder builder() {
        return ImmutableLocation.builder();
    }
}
